home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2005 October / PCWOCT05.iso / Software / FromTheMag / XAMPP 1.4.14 / xampp-win32-1.4.14-installer.exe / xampp / php / pear / docs / HTML_Progress / README < prev    next >
Text File  |  2004-03-24  |  7KB  |  163 lines
  1. $Id: README,v 1.1 2003/11/15 18:27:08 thesaur Exp $
  2.  
  3. ********************************************************************************
  4.  
  5.                 HTML_Progress
  6.  
  7. ********************************************************************************
  8.  
  9. ********************************************************************************
  10. Installation
  11. ********************************************************************************
  12.  
  13. Installation for HTML_Progress is as simple as any other PEAR classes.
  14. Just enter on command line:  pear install (tarball)
  15. where (tarball) is an archive file like  HTML_Progress-1.0.tgz
  16.     
  17. If you need more detailed help, check out INSTALL
  18.  
  19.  
  20. ********************************************************************************
  21. Release Notes
  22. ********************************************************************************
  23.  
  24. Release notes for the newest version are in Release-1.0
  25.  
  26. 1.0 is out, a STABLE bugfix release
  27.  
  28. To learn how to do, read online APIdoc and tutorials in many formats at 
  29. http://pear.laurent-laville.org/HTML/Progress/apidoc/
  30.  
  31. If you find a bug please send me a mail with subject HTML_Progress at:
  32. <pear@laurent-laville.org>
  33. Or put a new entry on PEAR BugTracker at :
  34. http://pear.php.net/bugs/search.php?cmd=display&status=Open&bug_type[]=HTML_Progress
  35.  
  36.  
  37. ********************************************************************************
  38. How To generate the API doc and tutorials (made with phpDocumentor 1.2.3)
  39. ********************************************************************************
  40. Guide is based on "HTML:frames:DOM/earthli" converter
  41.  
  42. ----
  43. First you need to hack a little phpDocumentor converters options.ini file.
  44. (PEAR\data\PhpDocumentor\phpDocumentor\Converters\HTML\frames\templates\DOM\earthli\options.ini)
  45.  
  46. In [ppage] section of options.ini, 
  47. # adds:
  48.     graphic = img
  49.     graphic->fileref = src
  50.     graphic/ = 
  51.   to allow display of images (progress screenshots).
  52.  
  53. # adds:
  54.     tip = <div class="tips">
  55.     /tip = </div>
  56.   to allow display of tips area
  57.   
  58. At end of options.ini file,
  59. # adds:
  60.     [tip_title]
  61.     ;tag_attr = true
  62.     ;attr_name = true
  63.     cdata_start = true
  64.     open = <img src="../media/tip.gif" />
  65.     close = 
  66.   if you want to have the little icon on left corner
  67.  
  68. ----
  69. Second you need to hack a little phpDocumentor converters stylesheet file.
  70. (PEAR\data\PhpDocumentor\phpDocumentor\Converters\HTML\frames\templates\DOM\earthli\templates\media\stylesheet.css)
  71.  
  72. # adds:
  73.     .tips { padding: 0.5em; margin-left: 2em; font-style: italic; font-size: 10pt; background-color: lightyellow; color: black; width: 80%;}
  74.   for Tips display
  75.  
  76. ----
  77. Finally, you have to run phpdoc (or perharps docBuilder - Webinterface):
  78.      phpdoc [commandline]
  79.      
  80. where command_line switches are :
  81.     -f <pathTo>HTML\Progress.php                               to parse main file
  82.     -d <pathTo>HTML\Progress,<pathTo>HTML\Progress\tutorials   to parse all subclasses and tutorial files
  83.         -po HTML_Progress                                          to restrict generation to HTML_Progress, NOT included Error_Raise
  84.         -o <you favorite output format>                            for example "HTML:frames:DOM/earthli"
  85.         -t <target directory>                                      where you want to put generated files
  86.  
  87.         
  88. ********************************************************************************
  89. General Notes
  90. ********************************************************************************
  91. HTML_Progress is hosted at http://pear.laurent-laville.org, with downloads and 
  92. online documentation
  93.  
  94. Project page:     http://pear.laurent-laville.org/HTML/Progress
  95. Documentation:  http://pear.laurent-laville.org/HTML/Progress/apidoc/
  96.  
  97.  
  98. HTML_Progress 1.0 is released under the PHP License version 3.0, text is in
  99. LICENSE file
  100.  
  101.  
  102. ********************************************************************************
  103. Feature Notes
  104. ********************************************************************************
  105.  
  106. HTML_Progress is a PEAR class that provides a way to add a loading bar 
  107. fully customizable in existing XHTML documents. Your browser should accept DHTML feature.
  108.  
  109. Features since version 0.5.0
  110.   - allows usage of an existing stylesheet for colors and size model
  111.   - all colors and size elements are customizable
  112.   - show or hide text percent information
  113.   - set/add and returns value of current status of progress
  114.   - compliant with all CSS/XHMTL standards
  115.   - integration with template engine ITx family is possible
  116.   - create horizontal and also vertival bar
  117.  
  118. Features since version 0.6.0
  119.   - optional message line come with progress status.
  120.   - percent text info is now floating all around the progress bar
  121.   - scale can be change (default is 100)
  122.   - legend of percent text info can be change (default is "%")
  123.   - progress bar will now take by default the optimized size (height, width)
  124.   - define font-size and color of each cell with new API setCell
  125.  
  126. Improvement since version 0.6.1
  127.   - ProgressMaker is a dynamic tools to build and test all functionalities
  128.  
  129. Improvement since version 0.6.2
  130.   - ProgressMaker got a new skin, and allows to keep previous settings
  131.   - Allows use of iframes solution to display 2 progress bar on same page
  132.  
  133. Features since version 1.0
  134.   - create horizontal and also vertival bar
  135.   - allows usage of an existing external StyleSheet and/or JavaScript 
  136.   - all elements (progress, cells, string) are customizable by their html properties
  137.   - percent/string is floating all around the progress bar
  138.   - compliant with all CSS/XHMTL standards
  139.   - integration with template engine IT[x] family is possible
  140.   - HTML_Progress now implements a Observer design pattern. It is possible to add Listeners.
  141.   - HTML_Progress now adds a customizable UI monitor pattern to display a progress bar. 
  142.     User-end can abort progress at any time.
  143.   - Look and feel can be sets by internal API or an external config file.
  144.   - Allows many progress bar on same page without uses of iframe solution. 
  145.  
  146.   
  147. If something is missing from this list make sure to file a feature request 
  148. at my mail address <pear@laurent-laville.org>
  149.  
  150.  
  151. ********************************************************************************
  152. Thanks
  153. ********************************************************************************
  154. Thanks to Klaus Guenther, author of great PEAR classes HTML_Page and HTML_CSS
  155. Thanks to Hans Lellelid to help me to find a config problem on HTML_Progress
  156. Thanks to Davey Shafik to help me to see problems on notice errors
  157. Thanks to Arnaud Limbourg to give me idea (Horz./Vert bars) to improve this package
  158. Thanks to Greg Beaver for warning about Call-time pass-by-reference has been deprecated
  159. Thanks to Stefan Neufeind for his enhancement-proposal to keep compatibility with Opera6
  160. Thanks to Christian Wenz to help me to fix javascript errors on IE4 and NS4 browsers
  161.  
  162. Special Thanks to Rasmus Lerdorf, without him PHP and all this universe won't be! 
  163.